Delete Customer Offer

This API is used to delete an individual offer (Regular Plan) or a Pool Plan that is not attached to any subscribers. for one of the customer children (sub-customers). Deactivation is done as a soft deletion procedure.

A customer offer cannot be deleted if any subscriber is connected to it. Therefore, any customer offer (Regular Plan or Pool Plan) must be detached as a prerequisite to deleting it. After deletion,, the customer offer cannot be recovered.

HTTP URL
DELETE	/api/v2/customer/{id}/offer/{id}

NOTE: Offer {id} is the catalog offering ID

Eligibility

The Requester is eligible to delete individual offers or Pool Plans that the Requester created for his sub-customers use. The Requester is not eligible to delete any other individual offers or Pool Plans.

API Request

This API has no request structure.

API Response

Response Structure

Parameter	Type	M/O/CM	Description
errorCode	String	O	Failure code.
errorMessage	String	O	Failure message.
content	Object	O	Array of main response body object displayed when an API call was successful. For a failure, it will be empty.
pageable	Object	O	Paging information object displayed when an API call was successful. For a failure, it will be empty.

Content data objects

Element	Type	M/O/CM	Description
requestId	UUID	M	Request instance ID. To be used by external systems to query the call (operation) status: In progress Successful Failed.

Element

Type

M/O/CM

Description

requestId

UUID

Request instance ID.

To be used by external systems to query the call (operation) status:

In progress

Successful

Failed.

Pageable data objects

Element	Type	M/O/CM	Description
page	Numeric	M	Page number
size	Numeric	M	Page size. Number of requested elements per page
totalPages	Numeric	M	Total amount of available pages per requested page size
totalElements	Numeric	M	Total amount of retrieved elements

Error Codes

In addition to the general success and failure codes, the following error codes are possible.

Code	Message
GLOBAL_1001	Service unavailable. Please try again
CUSTOMER_1002	Customer does not exist
AUTH_1008	Pool plan for your account was not found
CUSTOMER_1012	Unknown offer id
CUSTOMER_1014	Plan deletion failure. It is not allowed to delete a plan in use by subscribers

Examples

Request Body

Copy

{
}

Response Body: Success ACK

Copy

{
  "errorCode": "",
  "errorMessage": "",
  "content": [
    {
      "requestId": "ff74dca6-8e7f-4b85-a42b-13860913b370"
    }
  ],
  "pageable": {
    "page": 0,
    "size": 10,
    "totalPages": 1,
    "totalElements": 1
  }
}

Response Body: Failure NAK

Copy

{
  "errorCode": "GLOBAL_1014",
  "errorMessage": "Plan deletion failure. It is not allowed to delete a plan in use by subscribers",
  "content": "",
  "pageable": ""
}